provider Integrations PUT /api/0/organizations/{organization_id_or_slug}/forwarding/{data_forwarder_id}/
@utdk/sentry /api/0/organizations/{organization_id_or_slug}/forwarding/{data_forwarder_id}/
Update a Data Forwarder for an Organization
Updates a data forwarder for an organization or update a project-specific override. Updates to the data forwarder's configuration require `org:write` permissions, and the entire configuration to be provided, including the `project_ids` field. To configure project-specific overrides, specify only the following fields: - 'project_id': The ID of the project to create/modify the override for. - 'overrides': Follows the same format as `config` but all provider fields are optional, since only specified fields are overridden. - 'is_enabled': To enable/disable the forwarder for events on the specific project. Overrides can be performed with `project:write` permissions on the project being modified.
organization_id_or_slug path required
The ID or slug of the organization the resource belongs to.
string
data_forwarder_id path required
The ID of the data forwarder you'd like to query.
integer

Try it

Authentication
Configure credentials for API Reference
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

updateADataForwarderForAnOrganization
PUT/api/0/organizations/{organization_id_or_slug}/forwarding/{data_forwarder_id}/
Updates a data forwarder for an organization or update a project-specific override. Updates to the data forwarder's configuration require `org:write` permissions, and the entire configuration to be provided, including the `project_ids` field. To configure project-specific overrides, specify only the following fields: - 'project_id': The ID of the project to create/modify the override for. - 'overrides': Follows the same format as `config` but all provider fields are optional, since only specified fields are overridden. - 'is_enabled': To enable/disable the forwarder for events on the specific project. Overrides can be performed with `project:write` permissions on the project being modified.

Parameters

required

The ID or slug of the organization the resource belongs to.

required

The ID of the data forwarder you'd like to query.

Input

required

The ID of the organization related to the data forwarder.

required

The provider of the data forwarder. One of "segment", "sqs", or "splunk". * `segment` - Segment * `sqs` - Amazon SQS * `splunk` - Splunk

Whether the data forwarder is enabled.

Whether to enroll new projects automatically, after they're created.

The configuration for the data forwarder, specific to the provider type. For a 'sqs' provider, the required keys are queue_url, region, access_key, secret_key. If using a FIFO queue, you must also provide a message_group_id, though s3_bucket is optional. For a 'segment' provider, the required keys are write_key. For a 'splunk' provider, the required keys are instance_url, index, source, token.

The IDs of the projects connected to the data forwarder. Missing project IDs will be unenrolled if previously enrolled.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import sentry from '@utdk/sentry';

await sentry.updateADataForwarderForAnOrganization({
  "is_enabled": true,
  "enroll_new_projects": false
})